The commands in the services command node manage the Network Data Management Protocol (NDMP) and Simple Network Management Protocol (SNMP) services for a SpinServer system. NDMP is an open standard for controlling backups and restorations of NDMP-compliant file servers from NDMP-compliant data management applications (DMAs). SNMP is an open standard for monitoring and managing systems and devices on a network. SNMP is used on the SpinServer system to support the management of traps, which signal the occurrence of events.
The services command node includes the following subnode commands:
antivirus
firewall
ndmp
ntp
snmp
support
Each of the subnode and leaf-node commands is described in detail, with parameters and arguments listed for each command.
Examples of command usage are included in the discussions.
CLI:
services antivirus configuration modify -scannerenabled {true | false} -updatefileurl FTP_URL -autoupdateenabled {true | false} -schedule {#-Minutely | hourly | daily | weekly | monthly | yearly | N/A}
GUI: Navigate to the Services → Antivirus → Configuration node. In the table that is displayed, make the appropriate modifications, then run the Modify command from the drop-down menu.
The services antivirus configuration modify command enables you to modify the following configuration information for the antivirus service on a SpinServer cluster:
Whether the antivirus service is enabled
Whether to repair infected files
The URL from which to retrieve virus-database updates
Whether to automatically update the virus scanner
The schedule on which automatic updates occur
-scannerenabled {true | false}
This specifies whether virus scanning is enabled. The default is true.
-repairfiles {true | false}
This specifies whether the virus scanner attempts to repair infected files automatically. The default is true.
-updatefileurl FTP_URL
This specifes an FTP URL from which virus-database updates can be retrieved.
-autoupdateenabled {true | false}
This specifies whether virus-database updates are automatically retrieved from the FTP URL specified by the -updatefileurl parameter. The default is false.
-schedule {#-Minutely | hourly | daily | weekly | monthly | yearly | N/A}
This specifies the schedule on which virus-database updates are retrieved.
The following example enables virus scanning and automatic repair of infected files. It also enables automatic updates from an FTP site named ftp://ftp.spinnakernet.com/pub/antivirus/2.5/update.cfg. Updates occur weekly.
spinserver::> services antivirus configuration modify -scannerenabled true -repairfiles true -updatefileurl ftp://ftp.spinnakernet.com/pub/antivirus/2.5/update.cfg -autoupdateenabled true -schedule weekly
CLI:
services antivirus configuration show
GUI: Navigate to the Services → Antivirus → Configuration node.
The services antivirus configuration show command displays the following information about the antivirus configuration for a SpinServer cluster:
Latest scanner level
Whether antivirus scanning is enabled
Whether infected files are automatically repaired
FTP URL for updates
Whether automatic updates are enabled
The schedule for automatic updates
The following example displays antivirus configuration information for a SpinServer cluster.
spinserver::> services antivirus configuration show Latest Scanner Level 3 Enable AntiVirus Scanner Service true Repair Infected Files true URL for Update Info File ftp://ftp.spinnakernet.com/pub/antivirus/2.5/update.cfg Enable Auto Update true Auto Update Schedule weekly
CLI:
services antivirus configuration testurl
GUI: Navigate to the Services → Antivirus → Configuration node and run the Test Update Info URL command from the drop-down menu of the action pane.
The services antivirus configuration testurl command tests a download of the antivirus configuration file from the URL specified by the -updatefileurl parameter of the services antivirus configuration modify command. The test is run as a background job. The command returns a job ID; use the jobs show command to monitor the progress and outcome of the test.
The following example tests the download of an antivirus configuration file.
spinserver::> services antivirus configuration testurl
CLI:
services antivirus scanners delete -scannerlevel scanner_level
GUI: Navigate to the Services → Antivirus → Scanners node. Select a scanner level from the table and run the Delete command from the drop-down table of the action pane.
The services antivirus scanners delete command deletes a scanner level. In SpinAV terminology, a scanner is the combination of an antivirus engine and a virus-definition database.
-scannerlevel scanner_level
This is the scanner level (antivirus engine plus virus database) that is to be deleted.
The following example deletes scanner level 3:
spinserver::> services antivirus scanner delete -scannerlevel 3
CLI:
services antivirus scanners show [-scannerlevel scanner_level]
GUI: Navigate to the Services → Antivirus → Scanners node. To display information about a specific scanner level, select it from the table and run the Show command from the drop-down table of the action pane.
The services antivirus scanners show command displays information about one or more scanner levels. In SpinAV terminology, a scanner is the combination of an antivirus engine and a virus-definition database. The command displays the following information:
Scanner level
Engine version
Database version
[-scannerlevel scanner_level]
This is the scanner level (antivirus engine plus virus database) about which information is to be displayed.
The following example displays information about all scanner levels:
spinserver::> services antivirus scanner show Scanner Engine Database Level Version Version 2 1002 1001 3 1002 1002 4 1003 1002
The services antivirus servers leaf node contains the following commands:
deletescannerfiles
getlatestupdate
getupdate
setcurrent
show
CLI:
services antivirus servers deletescannerfiles -ssid spinserver -scanner scanner
GUI: Navigate to the Services → Antivirus → Servers node. Select a server from the table and run the Delete Scanner Files command from the drop-down table of the action pane. Enter the appropriate information into the table that is displayed, then click Delete Scanner Files.
The services antivirus servers deletescannerfiles command deletes antivirus-scanner files from a specified SpinServer.
-ssid spinserver
This is the name of the SpinServer from which scanner files are to be deleted.
-scanner scanner
This is the scanner level of the scanner files that are to be deleted.
The following example deletes the files for scanner 3 from a SpinServer named Server1:
spinserver::> services antivirus servers deletescannerfiles -ssid Server1 -scanner 3
CLI:
services antivirus servers getlatestupdate -ssid spinserver
GUI: Navigate to the Services → Antivirus → Servers node. Select a server from the table and run the Get Latest Update command from the drop-down table of the action pane.
The services antivirus servers getlatestupdate command downloads the latest antivirus update to a specified SpinServer and sets the updated files as the current scanner level. This command must be run on each SpinServer that requires updated antivirus files.
-ssid spinserver
This is the name of the SpinServer on which scanner files are to be updated.
The following example downloads the latest antivirus updates to a SpinServer named Server1:
spinserver::> services antivirus servers getlatestupdate -ssid Server1
CLI:
services antivirus servers getupdate -ssid spinserver -enginerurl URL_for_engine -databaseurl URL_for_database
GUI: Navigate to the Services → Antivirus → Servers node. Select a server from the table and run the Get Update command from the drop-down table of the action pane. Enter the appropriate information into the table that is displayed, then click Get Update.
The services antivirus servers getupdate command downloads a specific antivirus update in the form of an antivirus engine and a virus database file to a specified SpinServer, then sets the updated files as the current scanner level. This command must be run on each SpinServer that requires updated antivirus files.
-ssid spinserver
This is the name of the SpinServer on which scanner files are to be updated.
-engineurl URL_for_engine
This specifies the URL from which the engine database is to be downloaded.
-databaseurl URL_for_database
This specifies the URL from which the virus database file is to be downloaded.
The following example downloads an antivirus engine named eng-1007.tgz and a virus database named dat-1007.tgz from the FTP site ftp://ftp.spinnakernet.com/pub/antivirus/2.5 to a SpinServer named Server1, then sets the new files as the current scanner level:
spinserver::> services antivirus servers getlatestupdate -ssid Server1 -engineurl ftp::/ftp.spinnakernet.com/pub/antivirus/2.5/eng-1007.tgz -databaseurl ftp://ftp.spinnakernet.com/pub/antivirus/2.5/dat-1007.tgz
CLI:
services antivirus servers setcurrent -ssid spinserver -scanner scanner
GUI: Navigate to the Services → Antivirus → Servers node. Select a server from the table and run the Set Current Scanner command from the drop-down table of the action pane. Enter the appropriate information into the table that is displayed, then click Set Current Scanner.
The services antivirus servers setcurrent command sets the scanner level for a specific SpinServer.
-ssid spinserver
This is the name of the SpinServer on which the scanner level is to be set.
-scanner scanner
This specifies the scanner that is to be set as the current level.
The following example sets scanner level 1 as the current scanner on a SpinServer named Server1:
spinserver::> services antivirus servers setcurrent -ssid Server1 -scanner 1
CLI:
services antivirus servers show [-ssid spinserver]
GUI: Navigate to the Services → Antivirus → Servers node. To display information about a specific server, select it from the table and run the Show command from the drop-down table of the action pane.
The services antivirus servers show command displays information about the antivirus server on one or more SpinServers. Use the command with the -ssid parameter to display information aobut a specific SpinServer, or without the parameter to display information about all SpinServers in the cluster. The command displays the following information:
SpinServer ID
Scanner status (enabled or disabled)
Current scanner level
Number of downloaded scanners (a scanner is the combination of an antivirus engine and a virus database)
Automatic update status
When the -ssid parameter is specified to display information about the antivirus scanner on a particular SpinServer, the command displays the following additional information:
The time the current scanner was set
Whether an update is currently in progress
The time of the next automatic update
The time of the last automatic update
The last message from the automatic update process
The number of antivirus scans completed
The number of jobs in the high-priority queue
The number of jobs in the low-priority queue
The number of idle threads
[-ssid spinserver]
This is the name of the SpinServer about which antivirus information is to be displayed.
The following example displays information about the antivirus server on a SpinServer named Server1:
spinserver::> services antivirus servers show -ssid Server1 SpinServer ID Server1 Scanner Status Up Current Scanner Level 2 Time Current Scanner Set 10/23/03 6:01 PM Downloaded Scanners 1, 2 Update In Progress false Next Auto Update Time 10/30/03 12:00 AM Last Auto Update Time 10/29/03 12:00 AM Auto Update Status Succeeded Auto Update Message Currently using scanner:2 available at download server No. of Scans Completed 503158 High Priority Queue Depth 0 Low Priority Queue Depth 0 No. of Idle Threads 10
CLI:
services firewall configure modify -mgmtonservports {true | false} -svcsonservports {true | false} -svcsonmgmtport {true | false}
GUI: Navigate to the Services → Firewall → Configuration node. Make the appropriate changes to the table that is displayed, then run the Modify command from the drop-down menu of the action pane.
The services firewall configure modify command modifies the firewall configuration for the management and server ports in a SpinServer cluster.
-mgmtonservports {true | false}
This specifies whether management is accessible on server ports. The default is false.
-svcsonservports {true | false}
This specifies whether file-serving services are available on the server ports. The default is true.
-svcsonmgmtport {true | false}
This specifies whether file-serving services are available on the management port. The default is false.
The following example specifies that management is accessible on the server ports, services are accessible on the server ports, and services are not accessible on the management port:
spinserver::> services firewall configure modify -mgmtonservports true -svcsonservports true -svcsonmgmtport false
CLI:
services firewall configure show
GUI: Navigate to the Services → Firewall → Configuration node.
The services firewall configure show command displays the following information about the firewall configuration for the management and server ports in a SpinServer cluster:
Whether management access is enabled on server ports (true or false)
Whether service access is enabled on server ports (true or false)
Whether service access is enabled on the management port (true or false)
The revision number of the current configuration
The following example displays information about the firewall configuration for the management and server ports in the cluster:
spinserver::> services firewall configure show Mgmt On Server Ports false Services On Server Ports true Services On Mgmt Port true Configuration Revision 1
CLI:
services ndmp modify -ssid spinserver -enable {true | false} -username user_name -password user_password -cleartext {true | false}
GUI: Navigate to the Services → NDMP node, then select an NDMP service from the table and run the Show command from the drop-down menu of the action pane. In the table that is displayed, make the appropriate modifications, then run the Modify command from the drop-down menu.
The services ndmp modify command identifies a SpinServer and enables you to modify the following configuration information for an NDMP service:
Server enabled status
User name
User's password
Clear-text password on the network
-ssid spinserver
This is the ID given to the SpinServer.
-enable {true | false}
This specifies whether the SpinServer is enabled (true) or disabled (false).
-username user_name
This is name of the user.
-cleartext {true | false}
This specifies whether the clear-text password on the network is enabled (true) or disabled (false).
The following command example identifies an active SpinServer named Server1 and modifies the NDMP service. The username is chris, whose password is 0978. Clear-text passwords are enabled on the network.
spinserver::> services ndmp modify -ssid Server1 -enable true -username chris -password 0978 -cleartext true
CLI:
services ndmp show [-ssid spinserver]
GUI: Navigate to the Services → NDMP node. To display information about a particular NDMP service, select it from the table and run the Show command from the drop-down menu of the action pane.
The services ndmp show command displays NDMP configuration information about a SpinServer if the parameters are specified, and NDMP configuration information about all SpinServers if no parameters are specified. The command displays the following information about the NDMP configuration:
SpinServer ID
Status of server enablement
User name
User's password
Status of clear-text passwords on the network
The following command example displays NDMP configuration information for a SpinServer named Server1.
spinserver::> services ndmp show -ssid Server1
SpinServ Server Username Password Clear
ID Enabled Text
Passwd
Server1 false nouser nopassword false
CLI:
services ntp configure modify -clustername cluster_name -enabled {true | false} -usepdcs {true | false} -useclus {true | false}
GUI: Navigate to the Services → NTP → Cluster Configuration node. Select a configuration from the table and run the Show command from the drop-down table of the action pane. In the table that is displayed, make the appropriate modifications, then run the Modify command from the drop-down menu.
The services ntp configure modify command modifies the NTP configuration for a SpinServer cluster.
-clustername cluster_name
This is the name of the cluster.
-enabled {true | false}
This specifies whether or not to use NTP in the cluster. The default is true.
-usepdcs {true | false}
This specifies whether to use the time setting of the Windows primary domain controller (PDC). The default is false.
-useclus {true | false}
This specifies whether to use SpinServers in the cluster as NTP peers. The default is false.
The following example enables the use of NTP in a cluster named Clus1. PDC time is not used, and SpinServers in the cluster are not used as peers.
spinserver::> services ntp configure modify -clustername Clus1 -enabled true -usepdcs false -useclus false
CLI:
services ntp configure show [-clustername cluster_name]
GUI: Navigate to the Services → NTP → Cluster Configuration node. To display information about a particular configuration, select it from the table and run the Show command from the drop-down table of the action pane.
The services ntp configure show command displays the NTP configuration for a SpinServer cluster. The command displays the following information:
Cluster name
Whether NTP is enabled for the cluster
Whether Windows primary domain controller (PDC) time is used for the cluster
Configuration revision number
The following example displays information about the use of NTP in a cluster named Clus1.
spinserver::> services ntp configure show -clustername Clus1 Cluster Name Clus1 Enabled true Use PDC Time false Configuration Revision 0
CLI:
services ntp servers delete -ipaddress IP_address
GUI: Navigate to the Services → NTP → Time Servers node. Select an NTP server from the table and run the Delete command from the drop-down table of the action pane.
-ipaddress IP_address
This is the IP address of the NTP server whose reference is to be deleted.
The following example deletes the reference to an NTP server with the IP address 10.1.4.1:
spinserver::> services ntp servers delete -ipaddress 10.1.4.1
CLI:
services ntp servers new -ipaddress IP_address
GUI: Navigate to the Services → NTP → Time Servers node and click New in the top bar of the action pane. Enter the IP address of the NTP server into the table that is displayed, then click Create.
-ipaddress IP_address
This is the IP address of the NTP server to which a reference is to be added.
The following example creates a reference to an NTP server with the IP address 10.1.4.1:
spinserver::> services ntp servers new -ipaddress 10.1.4.1
CLI:
services ntp servers show [-ipaddress IP_address]
GUI: Navigate to the Services → NTP → Time Servers node. To display information about a particular NTP server, select it from the table and run the Show command from the drop-down table of the action pane.
The services ntp servers show command displays the IP address or addresses of one or more NTP servers.
[-ipaddress IP_address]
This is the IP address of the NTP server whose reference is to be deleted.
The following example displays information about the NTP servers that are configured to work with a SpinServer:
spinserver::> services ntp servers show
IP Address
10.1.4.1
10.2.4.1
The services snmp subnode contains the trapdest leaf node, which includes the following commands:
delete
modify
new
show
CLI:
services snmp trapdest delete -ipaddress IP_address
GUI: Navigate to the Services → SNMP → Trap Destinations node, then select a trap destination and run Delete command from the drop-down menu of the action pane.
-ipaddress IP_address
This specifies the IP address of the managing entity that receives SNMP traps.
The following command example deletes an SNMP trap destination on a managing entity with the IP address 10.10.127.1.
spinserver::> services snmp trapdest delete -ipaddress 10.10.127.1
CLI:
services snmp trapdest modify -ipaddress IP_address -trapport trap_port -community community -snmpversion SNMP_version
GUI: Navigate to the Services → SNMP → Trap Destinations node, then select a trap destination from the table and run the Show command from the drop-down menu in the action pane. In the table that is displayed, make the appropriate modifications, then run the Modify command from the drop-down menu.
-ipaddress IP_address
This specifies the IP address of the managing entity that receives SNMP traps.
-trapport trap_port
This specifies the port number of the managing entity that receives SNMP traps.
-community community
This specifies the SNMP community name of the managing entity.
-snmpversion SNMP_version
This specifies the SNMP version that is used by the managing entity. Possible values include SNMPv1 and SNMPv2c.
The following example modifies an SNMP trap destination on a managing entity with the IP address 10.10.127.1 and the port number 162. The managing entity belongs to an SNMP community named public and uses SNMPv1.
spinserver::> services snmp trapdest new -ipaddress 10.10.127.1 -trapport 162 -community public -snmpversion SNMPv1
CLI:
services snmp trapdest new -ipaddress IP_address -trapport trap_port -community community -snmpversion SNMP_version
GUI: Navigate to the Services → SNMP → Trap Destinations node, then click New in the top bar of the action pane. Enter the appropriate values into the table that is displayed and click Create.
-ipaddress IP_address
This specifies the IP address of the managing entity that is to receive SNMP traps.
-trapport trap_port
This specifies the port number of the managing entity that is to receive SNMP traps.
-community community
This specifies the SNMP community name of the managing entity.
-snmpversion SNMP_version
This specifies the SNMP version that is used by the managing entity. Possible values include SNMPv1 and SNMPv2c.
The following example creates an SNMP trap destination on a managing entity with the IP address 10.10.127.1 and the port number 162. The managing entity belongs to an SNMP community named public and uses SNMPv2c.
spinserver::> services snmp trapdest new -ipaddress 10.10.127.1 -trapport 162 -community public -snmpversion SNMPv2c
CLI:
services snmp trapdest show [-ipaddress IP_address]
GUI: Navigate to the Services → SNMP → Trap Destinations node. To display information for a specific trap destination, select it from the table and run the Show command from the drop-down table of the action pane.
The services snmp trapdest show command displays information about all SNMP trap destinations or about a specified SNMP trap destination. Use the command with the -ipaddress parameter to display information about a single SNMP trap destination, or without the parameter to display information about all SNMP trap destinations. The information displayed includes the following:
IP address of the managing entity
Port number of the managing entity
SNMP community to which the managing entity belongs
SNMP version used by the managing entity
[-ipaddress IP_address]
This specifies the IP address of the managing entity about which SNMP trap-destination information is to be displayed.
The following example displays information about all SNMP trap destinations:
spinserver::> services snmp trapdest show IP Address Trap Port Community SNMP Version 10.10.127.1 162 public SNMPv2c 10.10.127.2 162 public SNMPv1
The following services support configure commands enable you to manage automatic health monitoring for a cluster:
modify
show
CLI:
services support configure modify -enabled {true | false} -reportperiod {daily | weekly | monthly} -supportemail support_email_address
GUI: Navigate to the Services → Health Monitor → Configuration node. Make the appropriate changes to the table that is displayed, then run the Modify command from the drop-down menu of the action pane.
The services support configure modify command modifies the health-monitoring configuration for a SpinServer cluster.
-enabled {true | false}
This specifies whether health monitoring is enabled on the cluster. The default is true.
-reportperiod {daily | weekly | monthly}
This specifies how often health-monitoring reports are sent. The default is daily.
-supportemail support_email_address
This specifies the email address to which health-monitoring reports are sent. The default is support@spinnakernet.com.
The following example enables health monitoring on a weekly basis and emails reports to support@spinnakernet.com.
spinserver::> services support configure modify -enabled true -reportperiod weekly -supportemail support@spinnakernet.com
CLI:
services support configure show
GUI: Navigate to the Services → Health Monitor → Configuration node.
The services support configure show command displays the following information about the health-monitoring configuration for a SpinServer cluster:
Whether automatic health monitoring is enabled (true or false)
The period for health-monitoring reports (daily, weekly, or monthly)
The email address to which health reports are sent
The revision number of the current configuration
Copyright © 2004 Network Appliance, Inc.; copyright © 2003, 2004 Spinnaker Networks, LLC. All rights reserved. Specifications subject to change without notice.